A Custom Channel endpoint is used to create a connector for communication channels other than SMS, MMS, Mobile or Social. It can be used for example for Printing, Exports, Onsite Interventions or even call centers. A plugin needs to be installed on your environment for each one of the Custom Channels required.
Note: Custom Channels of type Print, Export, Call center or Onsite intervention can be used in a Cadence Plan.
The following fields can be configured:
- Name* — Provide a name that reflects the use of this Custom Channel endpoint. This name will be used in the Organization configuration when making the channel available for use.
- Type* — Select the type of endpoint here: Custom.
- Provider* — When you select Custom as the type of endpoint, you can select a specific plugin from a drop-down list here. The list of plugins displayed depends on the plugins installed on your environment. The parameters that need to be defined for a Custom Channel endpoint depend on the selected plugin.
- Channel — For Custom Channel Endpoints, if the selected provider (plugin) does not have a default channel set (eg. PDF Merger has a default channel of print, that can not be changed), you have the ability to select the desired channel here.
- API-Name* — The API-name attributed to the end point and used by the API.
- Description — Provide a description that reflects the use of this endpoint.
- Interval (minutes) — Throughput interval, expressed in minutes. This is a configurable value, which is 10 minutes by default.
- Batch size — Throughput batch size. This is a configurable value, which is 100 by default.
Example: For an 'X' (formerly Twitter) Custom Channel endpoint, a 'X' (formerly Twitter) key and secret are required as well as an authentication token and secret.
Note: The type and provider fields can only be selected during creation of a new channel endpoint. When editing an existing channel endpoint, they are read-only and can thus no longer be changed.
Once a Custom Channel endpoint has been created, it will be available from the library when creating a Custom Component.
Note: All parameters used by the Custom Channel endpoint are not stored in the plugin itself but in the properties of the Custom Channel endpoint. Hence, the same plugin can be used in multiple Custom Channel endpoints with different parameter values for each one.
